跳转到主要内容
POST
/
api
/
v1
/
instances
部署新实例(通过 `variantId` 目录驱动或显式指定)。
curl --request POST \
  --url https://openapi.beeos.ai/api/v1/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "variantId": "<string>",
  "agentFramework": "<string>",
  "providerId": "<string>",
  "providerConfig": {},
  "modelPrimary": "<string>",
  "models": [
    "<string>"
  ],
  "systemPrompt": "<string>",
  "mcpServers": {},
  "bridgeId": "<string>",
  "config": {},
  "clusterId": "<string>",
  "preferredRegion": "<string>"
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "ownerId": "<string>",
    "agentFramework": "<string>",
    "providerId": "<string>",
    "externalId": "<string>",
    "osType": "<string>",
    "hostingType": "<string>",
    "cloudProvider": "<string>",
    "name": "<string>",
    "modelPrimary": "<string>",
    "models": [
      "<string>"
    ],
    "status": "<string>",
    "desiredStatus": "<string>",
    "endpoint": "<string>",
    "bridgeId": "<string>",
    "identityId": "<string>",
    "totalRunSeconds": 123,
    "connectivity": "<string>",
    "providerConfig": {},
    "haltReason": "<string>",
    "publicIp": "<string>",
    "clusterId": "<string>",
    "region": "<string>",
    "imageId": "<string>",
    "imageRef": "<string>",
    "isTrial": true,
    "expiresAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>",
    "systemPrompt": "<string>",
    "mcpServers": {},
    "startedAt": "2023-11-07T05:31:56Z",
    "stoppedAt": "2023-11-07T05:31:56Z",
    "statusEnteredAt": "2023-11-07T05:31:56Z",
    "connectivityUpdatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "screenshotUrl": "<string>",
    "screenshotUpdatedAt": "2023-11-07T05:31:56Z"
  }
}

授权

Authorization
string
header
必填

通过 Authorization: Bearer <token> 头传递用户 JWToag_ 用户 API Key。

请求体

application/json

可以提供 目录 variantId(权威来源 — 从 variant 获取 agentFramework / providerId / 区域 / 调度策略),或者 显式指定 agentFramework(+ 可选的 providerId)。 客户端提供的调度字段(ownershipPreference / maxPricePerHour / resourceTypeHint)不在此处接受;目录 variant 是唯一来源。

name
string
必填

实例名称。

Maximum string length: 128
variantId
string

目录 variant ID。

Maximum string length: 128
agentFramework
string

智能体框架。

Maximum string length: 64
providerId
string

Provider ID。

Maximum string length: 64
providerConfig
object

自由格式的 Provider 特定配置,与目录配置合并 (冲突时目录优先)。

modelPrimary
string

主模型 ID。

Maximum string length: 128
models
string[]

可选的附加模型列表。

Maximum string length: 128
systemPrompt
string

系统提示词。

Maximum string length: 8192
mcpServers
object

MCP 服务器配置。

bridgeId
string

指定的 Bridge ID。

Maximum string length: 128
config
object

providerConfig 的替代名称;语义相同。

clusterId
string

指定的集群 ID。

Maximum string length: 128
preferredRegion
string

首选区域。

Maximum string length: 64

响应

201 - application/json

标准信封;data 为创建的实例。

success
boolean
必填
data
object
必填